Tootsville::Infinity-Get-Online-Users

Function

Infinity-Get-Online-Users names a function, with lambda list (D USER RECIPIENT/S):

Get a list of users online.

Lisp GET-ONLINE-USERS = JSON getOnlineUsers

This is an administrative function, only available to staff members.

Usage

{ c: "getOnlineUsers",
  d: { [ inRoom: ROOM ] }

If this contains an attribute of "inRoom" with a room moniker, we'll only return the users in that room. Otherwise, all users in the Zone will be returned.

This optional parameter should not be specified and will be ignored if present.

Example

{ c: "getOnlineUsers" }

Status 200 OK

{ from: "getOnlineUsers",
  status: true,
  inRoom: "@Tootsville",
  toots: [ TOOT-INFO, ... ] }

The toots array is a list of TOOTSVILLE TOOT-INFO JSON objects describing every user online at the moment. This can be quite large.

Status 403 Permission Denied

This is returned if the user is not a Builder Toot.

{ from: "getOnlineUsers",
  status: false,
  error: "That is a Builder Toot command." }

File

Defined in file src/infinity/legacy-commands.lisp.